Skip to content

Docs/simplify readme#25

Merged
helloml0326 merged 5 commits intomainfrom
docs/simplify-readme
Nov 5, 2025
Merged

Docs/simplify readme#25
helloml0326 merged 5 commits intomainfrom
docs/simplify-readme

Conversation

@XiaoBoAI
Copy link
Copy Markdown
Collaborator

@XiaoBoAI XiaoBoAI commented Nov 5, 2025

No description provided.

- Restructure README for better readability and clarity
- Simplify installation and quick start sections
- Streamline features section with clearer organization
- Add Auto-Rubric paper (2025-10-20)
- Add Taming the Judge paper (2025-10-17)
- Remove verbose documentation and consolidate navigation
- Update contributing guidelines formatting
- Add blue-to-purple gradient RM-Gallery logo at the top
- Move News section before Installation for better visibility
- Align with best practices for open source project READMEs
- Create logo.svg with consistent gradient colors (cyan-blue-purple-pink)
- Replace README logo with SVG for proper gradient rendering on GitHub
- RM gradient: #22d3ee → #3b82f6 → #6366f1 → #8b5cf6
- Gallery gradient: #6366f1 → #8b5cf6 → #a855f7 → #ec4899
- Update logo.svg gradients and spacing to match index.md design
- Replace README header logo with shared SVG asset
- Use same logo image in docs/index.md for consistent branding
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @XiaoBoAI, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the user experience by simplifying and modernizing the project's documentation. The primary goal is to make the README.md more concise and easier to digest, while also introducing a new, consistent visual identity through an SVG logo. These changes aim to provide a clearer and more engaging introduction to the RM-Gallery platform for new and returning users alike.

Highlights

  • README Simplification: The main README.md file has been significantly simplified, reducing its length by nearly half. This includes removing verbose sections, consolidating information, and streamlining the overall presentation to improve readability and conciseness.
  • New SVG Logo: A new, visually appealing SVG logo for 'RMGallery' has been introduced and added to the docs/images/ directory.
  • Branding Consistency: The new SVG logo has been integrated into both the README.md and the main documentation page (docs/index.md), replacing previous text-based or inline-styled titles to ensure consistent branding across the project's primary entry points.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@helloml0326 helloml0326 merged commit ccf97f5 into main Nov 5, 2025
1 of 2 checks passed
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly simplifies the README.md file, making it more concise and easier for new users to navigate. The introduction of an SVG logo and its use in both the README and the main documentation page is a great improvement for consistency and maintainability. I've added a couple of suggestions to improve the code examples and setup instructions in the new README to ensure they are complete and work as expected for users.

Comment on lines +74 to +79
from rm_gallery.core.reward import BasePointWiseReward

class CustomReward(BasePointWiseReward):
def _evaluate(self, sample, **kwargs):
# Your evaluation logic
return RewardResult(...)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The code example for creating a custom reward model is missing an import for RewardResult. This will cause a NameError if a user tries to run this code. Please add the import to make the example runnable.

Suggested change
from rm_gallery.core.reward import BasePointWiseReward
class CustomReward(BasePointWiseReward):
def _evaluate(self, sample, **kwargs):
# Your evaluation logic
return RewardResult(...)
from rm_gallery.core.reward import BasePointWiseReward
from rm_gallery.core.reward.schema import RewardResult
class CustomReward(BasePointWiseReward):
def _evaluate(self, sample, **kwargs):
# Your evaluation logic
return RewardResult(...)

which will take care of the formatting and linting automatically.
```shell
```bash
pip install -e .
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The pre-commit package needs to be installed for pre-commit install to work. pip install -e . might not install it. Consider adding pip install pre-commit to the instructions to ensure contributors can set up the environment correctly.

XiaoBoAI pushed a commit that referenced this pull request Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants